Skip to main content

DescribeIpv6Gateways

Description

call the DescribeIpv6Gateways interface to query the created IPv6 gateway.

Request Method

POST

Request Path

/apsara/route/Vpc/DescribeIpv6Gateways

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
PageSizeBODYintegerNo10Number of entries per page.
VpcIdBODYstringNovpc-123456xscd****VPC ID associated with IPv6 gateway.
PageNumberBODYintegerNo1current page number.
regionIdBODYstringYesNo sample value for this parameter.region id
Ipv6GatewayIdBODYstringNoipv6gw-123456xscd****IPv6 gateway ID.
RegionIdBODYstringYescn-huhehaotethe region ID to which the IPv6 gateway belongs. You can obtain the region ID by calling the DescribeRegions interface.
versionBODYstringNo2016-01-01version of api
NameBODYstringNoipv6GWthe name of the IPv6 gateway.

Return data

NameTypeSample valueDescription
StatusstringAvailablethe operating status of the IPv6 gateway.
DescriptionstringdescriptionforIPv6GWdescription information of IPv6 gateway.
PageSizeinteger19Number of entries per page.
RequestIdstringE3A06196-3E7C-490D-8F39-CB4B5A0CE8ADrequest ID.
InstanceChargeTypestringPostPaidIPv6 gateway billing method.
Ipv6GatewayIdstringipv6gw-hp3rwmtmfhgisxscd****IPv6 gateway ID.
BusinessStatusstringNormalIPv6 gateway status, value: Normal: normal. FinancialLocked: overdue lock.
Namestringnamethe name of the IPv6 gateway.
TotalCountinteger2The number of entries queried.
VpcIdstringvpc-123456xscd****VPC ID associated with IPv6 gateway.
PageNumberinteger1current page number.
ExpiredTimestring2018-12-20T14:51:23Zthe expiration time of the IPv6 gateway.
CreationTimestring2018-12-20T14:51:23Zthe creation time of the IPv6 gateway.
RegionIdstringcn-huhehaotethe region of the IPv6 gateway.
SpecstringSmallIPv6 gateway specifications.
Ipv6GatewaysNo sample value for this parameter.IPv6 gateway details.

Example

Successful Response example

{
"Status":"Available",
"Description":"descriptionforIPv6GW",
"PageSize":"19",
"RequestId":"E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
"InstanceChargeType":"PostPaid",
"Ipv6GatewayId":"ipv6gw-hp3rwmtmfhgisxscd****",
"BusinessStatus":"Normal",
"Name":"name",
"TotalCount":"2",
"VpcId":"vpc-123456xscd****",
"PageNumber":"1",
"ExpiredTime":"2018-12-20T14:51:23Z",
"CreationTime":"2018-12-20T14:51:23Z",
"RegionId":"cn-huhehaote",
"Spec":"Small",
"Ipv6Gateways":""
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}